Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Utilize the reusable PHPUnit workflow for code coverage reporting. #7631

Closed
wants to merge 15 commits into from
Closed

Utilize the reusable PHPUnit workflow for code coverage reporting. #7631

wants to merge 15 commits into from

Conversation

desrosj
Copy link
Contributor

@desrosj desrosj commented Oct 23, 2024 •
edited
Loading

The workflow responsible for generating code coverage reports and submitting them to Codecov.io (coverage analysis page) has a few shortcomings. Mainly, the logic for setting up and running PHPUnit tests is duplicated making more work for maintaining.

The workflow should be updated to make use of the reusable-phpunit-tests-v#.yml reusable workflow file.

Other improvements that can be made:

  • There is currently no concurrency configured for this workflow. This prevents multiple workflows for the same change from being run at the same time. For PRs, only the newest one should run, and there should only ever be one running at a time for a specific commit.
  • The workflow currently runs 4 different jobs to generate two report formats each for multisite and single site. PHPUnit supports generating multiple reports at the same time. The number of jobs can be cut in half.
  • The workflow only runs for PRs when related files are changed. But when it runs, the report is not submitted to Codecov.io. This is supported and should be done as a way to fully test the workflow.

Trac ticket: https://core.trac.wordpress.org/ticket/62296

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@desrosj desrosj self-assigned this Oct 23, 2024
@github-actions GitHub Actions
Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@desrosj desrosj marked this pull request as ready for review October 24, 2024 14:03
@github-actions GitHub Actions
Copy link

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props desrosj.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@desrosj
Copy link
Contributor Author

desrosj commented Oct 24, 2024

Merged in https://core.trac.wordpress.org/changeset/59287.

@desrosj desrosj closed this Oct 24, 2024
@desrosj desrosj deleted the use/reusable-php-for-coverage branch October 24, 2024 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@desrosj desrosj

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@desrosj